[beta] Create a ridership route setup.

Create the passenger assignment setup for a route.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Ridership under the Ridership category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

POST /ridership/route-setups

[beta] Create a ridership route setup.

cURL

curl --request POST \
  --url https://api.samsara.com/ridership/route-setups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "e4b2c3a5-7d6f-4e8b-9a0c-1b2d3e4f5a6b",
  "passengers": [
    {
      "passengerId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "dropOffStopId": "790",
      "pickUpStopId": "789"
    }
  ],
  "routeId": "123456"
}
'

200

{
  "data": {
    "accountId": "e4b2c3a5-7d6f-4e8b-9a0c-1b2d3e4f5a6b",
    "createdAtTime": "2024-11-15T10:00:00Z",
    "passengers": [
      {
        "passengerId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "dropOffStopId": "790",
        "pickUpStopId": "789"
      }
    ],
    "routeId": "123456",
    "updatedAtTime": "2024-11-15T10:30:00Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

accountId · string · required

The Samsara UUID of the ridership account.

Example:

"e4b2c3a5-7d6f-4e8b-9a0c-1b2d3e4f5a6b"

passengers · object[] · required

List of passenger assignments for the route.

Show child attributes

routeId · string · required

The route ID. This is the Samsara route ID returned by the Routing API.

Example:

"123456"

Response

200

application/json

OK response.

data · object · required

A ridership route setup representing planned passenger assignments.

Show child attributes